Products
In-IDE
IDE extension that lets you fix coding issues before they exist!
Discover SonarLint
SaaS
Setup is effortless and analysis is automatic for most languages
Discover SonarCloud
Self-Hosted
Fast, accurate analysis; enterprise scalability
Discover SonarQube

Secrets
ABAP
Ansible
Apex
AzureResourceManager
C
C#
C++
CloudFormation
COBOL
CSS
Dart
Docker
Flex
Go
HTML
Java
JavaScript
JCL
Kotlin
Kubernetes
Objective C
PHP
PL/I
PL/SQL
Python
RPG
Ruby
Scala
Swift
Terraform
Text
TypeScript
T-SQL
VB.NET
VB6
XML

TypeScript static code analysis

Unique rules to find Bugs, Vulnerabilities, Security Hotspots, and Code Smells in your TYPESCRIPT code

Tags

Impact

Clean code attribute

Function returns should not be invariant
Code Smell
Assertions should be complete
Code Smell
Tests should include assertions
Code Smell
Test files should contain at least one test case
Code Smell
Octal values should not be used
Code Smell
Switch cases should end with an unconditional "break" statement
Code Smell
"switch" statements should not contain non-case labels
Code Smell
Equality operators should not be used in "for" loop termination conditions
Code Smell
Tests should not execute any code after "done()" is called
Code Smell
Union and intersection types should not include duplicated constituents
Code Smell
"default" clauses should be last
Code Smell
"await" should only be used with promises
Code Smell
Conditionals should start on new lines
Code Smell
Cognitive Complexity of functions should not be too high
Code Smell
"void" should not be used
Code Smell
Variables should be declared with "let" or "const"
Code Smell
Constructor names should start with an upper case letter
Code Smell
Loop counters should not be assigned within the loop body
Code Smell
Functions should not be nested too deeply
Code Smell
"for" loop increment clauses should modify the loops' counters
Code Smell
Functions should not be empty
Code Smell
Comma operator should not be used
Code Smell
Module should not import itself
Code Smell
Constructors should not contain asynchronous operations
Code Smell
Mutable variables should not be exported
Code Smell
Heading elements should have accessible content
Code Smell
Anchor tags should not be used as buttons
Code Smell
Interactive DOM elements should not have non-interactive ARIA roles
Code Smell
Non-interactive DOM elements should not have interactive ARIA roles
Code Smell
"tabIndex" values should be 0 or -1
Code Smell
DOM elements should use the "autocomplete" attribute correctly
Code Smell
Focusable elements should not have "aria-hidden" attribute
Code Smell
No ARIA role or property for unsupported DOM elements
Code Smell
No redundant ARIA role
Code Smell
DOM elements with ARIA roles should have a valid non-abstract role
Code Smell
Prefer tag over ARIA role
Code Smell
DOM elements with ARIA role should only have supported properties
Code Smell
DOM elements with ARIA roles should have the required properties
Code Smell
ARIA properties in DOM elements should have valid values
Code Smell
React legacy lifecycle methods should not be used
Code Smell
String references should not be used
Code Smell
React's "isMounted" should not be used
Code Smell
React's "findDOMNode" should not be used
Code Smell
All "defaultProps" should have non-required PropTypes
Code Smell
Spacing between inline elements should be explicit
Code Smell
User-defined JSX components should use Pascal case
Code Smell
Unused React typed props should be removed
Code Smell
JSX special characters should be escaped
Code Smell
"shouldComponentUpdate" should not be defined when extending "React.PureComponent"
Code Smell
React props should be read-only
Code Smell
The return value of "useState" should be destructured and named symmetrically
Code Smell
The return value of "ReactDOM.render" should not be used
Code Smell
Redundant React fragments should be removed
Code Smell
React "children" should not be passed as prop
Code Smell
JSX elements should not use unknown properties and attributes
Code Smell
In React "this.state" should not be mutated directly
Code Smell
If statements should not be the only statement in else blocks
Code Smell
Octal escape sequences should not be used
Code Smell
Prototypes of builtin objects should not be modified
Code Smell
Users should not use internal APIs
Code Smell
"as const" assertions should be preferred
Code Smell
Enum members should not mix value types
Code Smell
Enum values should be unique
Code Smell
Enum member values should be either all initialized or none
Code Smell
Unnecessary type constraints should be removed
Code Smell
Redundant type aliases should not be used
Code Smell
Ends of strings should be checked with "startsWith()" and "endsWith()"
Code Smell
All enum members should be literals
Code Smell
Unnecessary character escapes should be removed
Code Smell
Import variables should not be reassigned
Code Smell
JSX list components keys should match up between renders
Code Smell
React Context Provider values should have stable identities
Code Smell
JSX list components should not use array indexes as key
Code Smell
React components should not be nested
Code Smell
JSX list components should have a key property
Code Smell
Unused methods of React components should be removed
Code Smell
Character classes in regular expressions should not contain only one character
Code Smell
Regular expressions should not contain empty groups
Code Smell
Regular expressions should not contain multiple spaces
Code Smell
Chai assertions should have only one reason to succeed
Code Smell
Single-character alternations in regular expressions should be replaced with character classes
Code Smell
Reluctant quantifiers in regular expressions should be followed by an expression that can't match the empty string
Code Smell
Tests should be stable
Code Smell
Tests should check which exception is thrown
Code Smell
Character classes in regular expressions should not contain the same character twice
Code Smell
Names of regular expressions named groups should be used
Code Smell
Regular expressions should not be too complicated
Code Smell
HTML "<table>" should not be used for layout purposes
Code Smell
Optional property declarations should not use both '?' and 'undefined' syntax
Code Smell
Shorthand promises should be used
Code Smell
Template literals should not be nested
Code Smell
"undefined" should not be passed as the value of optional parameters
Code Smell
"in" should not be used on arrays
Code Smell
Assignments should not be redundant
Code Smell
Functions should not have identical implementations
Code Smell
Sparse arrays should not be created with extra commas
Code Smell
Array-mutating methods should not be used misleadingly
Code Smell
Collection contents should be used
Code Smell
Literals should not be thrown
Code Smell
Array indexes should be numeric
Code Smell
Assertion arguments should be passed in the correct order
Code Smell
Ternary operators should not be nested
Code Smell
Fields that are only assigned in the constructor should be "readonly"
Code Smell
"delete" should not be used on arrays
Code Smell
"indexOf" checks should not be for positive numbers
Code Smell
"arguments.caller" and "arguments.callee" should not be used
Code Smell
Multiline blocks should be enclosed in curly braces
Code Smell
Boolean expressions should not be gratuitous
Code Smell
Variables should be used in the blocks where they are declared
Code Smell
Methods should not contain selector parameters
Code Smell
Parameters should be passed in the correct order
Code Smell
Two branches in a conditional structure should not have exactly the same implementation
Code Smell
Unused assignments should be removed
Code Smell
Function parameters with default values should be last
Code Smell
Tests should not be skipped without providing a reason
Code Smell
Functions should not be defined inside loops
Code Smell
"switch" statements should not have too many "case" clauses
Code Smell
Only "while", "do", "for" and "switch" statements should be labelled
Code Smell
Sections of code should not be commented out
Code Smell
Track uses of "FIXME" tags
Code Smell
Assignments should not be made from within sub-expressions
Code Smell
Labels should not be used
Code Smell
Nested blocks of code should not be left empty
Code Smell
Functions should not have too many parameters
Code Smell
Unused private class members should be removed
Code Smell
Deprecated React APIs should not be used
Code Smell
Imports should not use absolute paths
Code Smell
Label elements should have a text label and an associated control
Code Smell
Elements with an interactive role should support focus
Code Smell
Images should have a non-redundant alternate description
Code Smell
Non-interactive DOM elements should not have an interactive handler
Code Smell
Non-interactive elements shouldn't have event handlers
Code Smell
DOM elements should not use the "accesskey" property
Code Smell
Non-interactive DOM elements should not have the `tabIndex` property
Code Smell
"case" and "default" clauses should not contain lexical declarations
Code Smell
Anchors should contain accessible content
Code Smell
DOM elements with the `aria-activedescendant` property should be accessible via the tab key
Code Smell
"Number.isNaN()" should be used to check for "NaN" value
Code Smell
Calls to ".call()" and ".apply()" methods should not be redundant
Code Smell
Literals should not be used for promise rejection
Code Smell
Spread syntax should be used instead of "apply()"
Code Smell
Object spread syntax should be used instead of "Object.assign"
Code Smell
__proto__ property should not be used
Code Smell
Use Object.hasOwn static method instead of hasOwnProperty
Code Smell
Renaming import, export, and destructuring assignments should not be to the same name
Code Smell
Unnecessary constructors should be removed
Code Smell
Ternary operator should not be used instead of simpler alternatives
Code Smell
Unnecessary calls to ".bind()" should not be used
Code Smell
Constructors should not return values
Code Smell
Nullish coalescing should be preferred
Code Smell
Function types should be preferred
Code Smell
"RegExp.exec()" should be preferred over "String.match()"
Code Smell
Optional chaining should be preferred
Code Smell
Type constituents of unions and intersections should not be redundant
Code Smell
Non-null assertions should not be used misleadingly
Code Smell
Prefer the return type "this" in fluent interfaces
Code Smell
Objects and classes converted or coerced to strings should define a "toString()" method
Code Smell
Extra boolean casts should be removed
Code Smell
Regular expression quantifiers and character classes should be used concisely
Code Smell
Regular expression literals should be used when possible
Code Smell
"<object>" tags should provide an alternative content
Code Smell
HTML elements should have a valid language attribute
Code Smell
Redundant casts and non-null assertions should be avoided
Code Smell
Type aliases should be used
Code Smell
Type predicates should be used
Code Smell
"module" should not be used
Code Smell
"for of" should be used with Iterables
Code Smell
Media elements should have captions
Code Smell
Imports from the same module should be merged
Code Smell
Jump statements should not be redundant
Code Smell
The global "this" object should not be used
Code Smell
"catch" clauses should do more than rethrow
Code Smell
Exceptions should not be ignored
Code Smell
Classes should not be empty
Code Smell
Boolean checks should not be inverted
Code Smell
Deprecated APIs should not be used
Code Smell
Wrapper objects should not be used for primitive types
Code Smell
Multiline string literals should not be used
Code Smell
Function call arguments should not start on new lines
Code Smell
Public "static" fields should be read-only
Code Smell
"if" statements should be preferred over "switch" when simpler
Code Smell
A "while" loop should be used instead of a "for" loop
Code Smell
Nested code blocks should not be used
Code Smell
Unnecessary imports should be removed
Code Smell
Boolean literals should not be used in comparisons
Code Smell
iFrames must have a title
Code Smell
Image, area, button with image and object elements should have an alternative text
Code Smell
Class names should comply with a naming convention
Code Smell
Track uses of "TODO" tags
Code Smell
Variables declared with "var" should be declared before they are used
Code Smell
Track lack of copyright and license headers
Code Smell
A conditionally executed single line should be denoted by indentation
Code Smell
Class methods should be used instead of "prototype" assignments
Code Smell
Unchanged variables should be marked as "const"
Code Smell
Wildcard imports should not be used
Code Smell
"switch" statements should not be nested
Code Smell
Cyclomatic Complexity of functions should not be too high
Code Smell
"strict" mode should be used with caution
Code Smell
Control flow statements "if", "for", "while", "switch" and "try" should not be nested too deeply
Code Smell
"switch" statements should have "default" clauses
Code Smell
"if ... else if" constructs should end with "else" clauses
Code Smell
Control structures should use curly braces
Code Smell
String literals should not be duplicated
Code Smell
Expressions should not be too complex
Code Smell
Increment (++) and decrement (--) operators should not be used in a method call or mixed with other operators in an expression
Code Smell
Disallow `.bind()` and arrow functions in JSX props
Code Smell
Optional boolean parameters should have default value
Code Smell
Union types should not have too many elements
Code Smell
Dependencies should be explicit
Code Smell
"this" should not be assigned to variables
Code Smell
The "any" type should not be used
Code Smell
"for in" should not be used with iterables
Code Smell
Functions should use "return" consistently
Code Smell
"arguments" should not be accessed directly
Code Smell
Comparison operators should not be used with strings
Code Smell
Property getters and setters should come in pairs
Code Smell
JavaScript parser failure
Code Smell
The ternary operator should not be used
Code Smell
"===" and "!==" should be used instead of "==" and "!="
Code Smell
Functions should not have too many lines of code
Code Smell
Track comments matching a regular expression
Code Smell
Statements should be on separate lines
Code Smell
Unused function parameters should be removed
Code Smell
Variables should not be shadowed
Code Smell
Redundant pairs of parentheses should be removed
Code Smell
Magic numbers should not be used
Code Smell
Mergeable "if" statements should be combined
Code Smell
Standard outputs should not be used directly to log anything
Code Smell
Files should not have too many lines of code
Code Smell
Lines should not be too long
Code Smell
"continue" should not be used
Code Smell
"await" should not be used redundantly
Code Smell
Primitive return types should be used
Code Smell
Default type parameters should be omitted
Code Smell
Type assertions should use "as"
Code Smell
Method overloads should be grouped together
Code Smell
Interfaces should not be empty
Code Smell
Trailing commas should be used
Code Smell
"import" should be used to include external code
Code Smell
Braces and parentheses should be used consistently with arrow functions
Code Smell
Destructuring syntax should be used for assignments
Code Smell
Template strings should be used instead of concatenation
Code Smell
Shorthand object properties should be grouped at the beginning or end of an object declaration
Code Smell
Object literal shorthand syntax should be used
Code Smell
Strings and non-strings should not be added
Code Smell
Default export names and file names should match
Code Smell
Primitive types should be omitted from initialized or defaulted declarations
Code Smell
Non-null assertions should not be used
Code Smell
"undefined" should not be assigned
Code Smell
Trailing commas should not be used
Code Smell
Array constructors should not be used
Code Smell
Local variables should not be declared and then immediately returned or thrown
Code Smell
Quotes for string literals should be used consistently
Code Smell
Statements should end with semicolons
Code Smell
Comments should not be located at the end of lines of code
Code Smell
Loops should not contain more than a single "break" or "continue" statement
Code Smell
Variable, property and parameter names should comply with a naming convention
Code Smell
Lines should not end with trailing whitespaces
Code Smell
Files should end with a newline
Code Smell
Extra semicolons should be removed
Code Smell
An open curly brace should be located at the end of a line
Code Smell
Tabulation characters should not be used
Code Smell
Function and method names should comply with a naming convention
Code Smell

DOM elements with ARIA roles should have a valid non-abstract role

intentionality - logical

maintainability

reliability

Code Smell

MajorSonarSource default severity
click to learn more

react
accessibility

Why is this an issue?

How can I fix it?

More Info

ARIA (Accessible Rich Internet Applications) attributes are used to enhance the accessibility of web content and web applications. These attributes provide additional information about an element’s role, state, properties, and values to assistive technologies like screen readers.

This rule checks that when using the role property in DOM elements, its value is a valid non-abstract ARIA role.

This rule does not cover non-DOM elements, such as custom components.

Available In:

Catch issues on the fly,
in your IDE

Detect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories

Analyze code in your
on-premise CI

© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.

Sonar helps developers write Clean Code.
Privacy Policy | Cookie Policy

In-IDE

SaaS

Self-Hosted